Skip to main content

Update Push Recommendation

πŸ“ Overview​

The UpdatePushRecommendation API is used to update an existing recommendation and notify clients via push notification.

πŸ”— Endpoint​

MethodURL
POST<protocol>://<host name>:<service port>/<service name>/<tenantid>/v1/UpdatePushRecommendation

Request​

The request comprises the following parameters:

πŸ“¦ Request Parameters​

ParameterData TypeMandatory / OptionalDescription
sessionKeystringMandatorySession key from AuthenticateKeys API, passed as a Bearer Authorization header.
parentRecoIDstringMandatoryRecommendation ID of the parent recommendation. Returned from the SendPushRecommendation API. Used for all subsequent updates of the same recommendation.
recoTypestringMandatoryValue must be taken from Update Recommendation Types table.
pricestringOptionalUpdated recommended price (e.g., 27.55). "Mkt" if blank or zero.
squareoffPricestringOptionalUpdated square‑off price. Must be > price for buy, < price for sell. "Mkt" if blank or zero.
stoplossPricestringOptionalUpdated stop-loss price. Must be < price for buy, > price for sell. "Mkt" if blank or zero.
qtyPercentagestringOptionalUpdated recommended quantity percentage (where applicable).
messageTitlestringOptionalPush notification title. Default: "RESEARCH CALL MODIFIED".
reportUrlstringOptionalURL of updated analysis report.
endTimestringOptionalUpdated validity date/time. Format: ddMMMyyyy HH:mm:ss (e.g., 31Jul2019 23:59:00). Defaults to today’s date if not passed.
uniqueIDstringOptionalUnique reference ID for your tracking.

Example Request​

Headers​

{
"Authorization": "Bearer eyBDyGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJDdXN0b21lcklkIjoiMTUyMyIsIm5Ob2RlTGljZW5zZUV4cGlyeSI6IjE4OTM2MDkwMDAiLCJpYXQiOjE1NjM2MDI2Nzd9.oRVgIlN3K_m5AXh_K1M88exzBg96CYJEVo_LQ-YZ6Yd"
}

Request Body​

{
"parentRecoID": "245WAADOAA",
"recoType": "108",
"price": "50.95",
"squareoffPrice": "55.35",
"stoplossPrice": "46.55",
"qtyPercentage": "",
"messageTitle": "INTRADAY CALL UPDATE",
"reportUrl": "",
"endTime": "31Jul2019 23:59:00",
"uniqueID": "31072019121508"
}

Response​

The ResponseObject contains the following parameters in a JSON structure:

πŸ§ͺ Response Parameters​

Parameter (Key)Data TypeDescription
statusbooleanIndicates the status of the request. true if the response is successful, false if an error occurred.
errorCodestringError code if any error occurred.
errorStringstringError description.
recoIDstringSystem‑generated recommendation ID used for further updates of this recommendation.

Example Response​

{
"status": true,
"errorCode": "",
"errorString": "",
"recoID": "245WAADOAB"
}